Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(README): improve configuration files documentation #1

Closed
wants to merge 11 commits into from

Conversation

SantiagoPittella
Copy link
Collaborator

No description provided.

bobbinth and others added 10 commits July 6, 2024 11:56
This removes the need to edit each crate's toml file when bumping the
version.
* refactor: move config extration into load_config

* feat(node): load config separate per component

This will let us specialize NodeConfig as currently it is supporting
multiple things.

* feat(node): normalize NodeConfig

Remove redundant properties from the config options. This prevents user
issues as only a single source of truth is allowed.

* fix: configs ignore unknown properties

Ignoring unknown configuration fields can lead to confusion
as the user has no indication that it was ignored.

Unknown properties now result in an error.

* chore(node): update miden-node.toml config file

* chore: update changelog
Use `Option<NonZeroU32>` instead of relying on zero to indicate none.
This removes the need to separately bundle this resource, simplifying
the deployment process.

The server url is now determined using the webpage url instead
of being hardcoded to localhost. This means we no longer have to
manually edit it to whatever IP it is being served on.
* tests: refactor, add tests for transaction batch

* refactor: move mock methods to `test_utils`

* tests: implement tests for batch/block producers and in-flight notes verifications

* fix: clippy warnings

* tests: fix getting unauthenticated input notes in `MockStoreSuccess`

* tests: cache mocked private accounts in order to reuse them on next creations

* tests: don't use 0's account index

* tests: fix block builder test

* format: apply rustfmt after merging

* fix: clippy warnings

* refactor: address review comments

* refactor: accept suggestion from the review

Co-authored-by: Mirko von Leipzig <[email protected]>

* tests: address review comments

---------

Co-authored-by: Mirko von Leipzig <[email protected]>
@SantiagoPittella SantiagoPittella force-pushed the fix-documentation-in-readme branch 2 times, most recently from 0ba3435 to b0a4839 Compare July 23, 2024 14:25
@SantiagoPittella SantiagoPittella force-pushed the fix-documentation-in-readme branch from b0a4839 to 10f0330 Compare July 24, 2024 10:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants